winit - Cross-platform window creation and management in Rust

[dependencies]
winit = "0.26.1"

Documentation

For features within the scope of winit, see FEATURES.md.

For features outside the scope of winit, see Missing features provided by other crates in the wiki.

Contact Us

Join us in any of these:

Usage

Winit is a window creation and management library. It can create windows and lets you handle events (for example: the window being resized, a key being pressed, a mouse movement, etc.) produced by window.

Winit is designed to be a low-level brick in a hierarchy of libraries. Consequently, in order to show something on the window you need to use the platform-specific getters provided by winit, or another library.

use winit::{
    event::{Event, WindowEvent},
    event_loop::{ControlFlow, EventLoop},
    window::WindowBuilder,
};

fn main() {
    let event_loop = EventLoop::new();
    let window = WindowBuilder::new().build(&event_loop).unwrap();

    event_loop.run(move |event, _, control_flow| {
        *control_flow = ControlFlow::Wait;

        match event {
            Event::WindowEvent {
                event: WindowEvent::CloseRequested,
                window_id,
            } if window_id == window.id() => *control_flow = ControlFlow::Exit,
            _ => (),
        }
    });
}

Winit is only officially supported on the latest stable version of the Rust compiler.

Cargo Features

Winit provides the following features, which can be enabled in your Cargo.toml file:

• serde: Enables serialization/deserialization of certain types with Serde.
• x11 (enabled by default): On Unix platform, compiles with the X11 backend
• wayland (enabled by default): On Unix platform, compiles with the Wayland backend
• mint: Enables mint (math interoperability standard types) conversions.

Platform-specific usage

WebAssembly

Winit supports compiling to the wasm32-unknown-unknown target with web-sys.

On the web platform, a Winit window is backed by a <canvas> element. You can either provide Winit with a <canvas> element, or let Winit create a <canvas> element which you can then retrieve and insert it into the DOM yourself.

For example code using Winit with WebAssembly, check out the web example. For information on using Rust on WebAssembly, check out the Rust and WebAssembly book.

Android

This library makes use of the ndk-rs crates, refer to that repo for more documentation.

The ndk_glue version needs to match the version used by winit. Otherwise, the application will not start correctly as ndk_glue's internal NativeActivity static is not the same due to version mismatch.

ndk_glue <-> winit version comparison compatibility:

Running on an Android device needs a dynamic system library, add this to Cargo.toml:

[[example]]
name = "request_redraw_threaded"
crate-type = ["cdylib"]

And add this to the example file to add the native activity glue:

#[cfg_attr(target_os = "android", ndk_glue::main(backtrace = "on"))]
fn main() {
    ...
}

And run the application with cargo apk run --example request_redraw_threaded

MacOS

To ensure compatibility with older MacOS systems, winit links to CGDisplayCreateUUIDFromDisplayID through the CoreGraphics framework. However, under certain setups this function is only available to be linked through the newer ColorSync framework. So, winit provides the WINIT_LINK_COLORSYNC environment variable which can be set to 1 or true while compiling to enable linking via ColorSync.